home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / pc / THDID9~1.ZIP / THEYDID.DOC < prev    next >
Encoding:
Text File  |  1993-10-30  |  13.3 KB  |  434 lines

  1.  
  2.  
  3.  
  4.  
  5.                        ╓──╥──┐          ─╥────┐
  6.                           ║              ║    │ *
  7.                           ║ ╥  ┬╥──┐╥  ┬ ║    │─╥─╥──┐
  8.                           ║ ╟──┤╟─  ╙──┤ ║    │ ║ ║  │
  9.                           ╨ ╨  ┴╨──┘╙──┘─╨────┘─╨─╨──┘
  10.                  ─────────────────────────────────────────────
  11.                      (c)Copyrigh 1992-93 Niclas Pettersson
  12.                    ─────────────────────────────────────────
  13.                                  TheyDid 0.93ß
  14.                    ─────────────────────────────────────────
  15.                         Programmed By Niclas Pettersson
  16.                    Design, Idea And Manual By Andreas Olsson
  17.                  ─────────────────────────────────────────────
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.    ──────────────────────────────────────────────────────────────────────────
  25.    0.  CONTENTS
  26.    ══════════════════════════════════════════════════════════════════════════
  27.  
  28.  
  29.  
  30.  
  31.                                C O N T E N T S
  32.                                ───────────────
  33.  
  34.                            1.  INTRODUCTION
  35.                            2.  WARRANTY AND DISCLAIMER
  36.                            3.  REGISTRATION
  37.                            4.  INSTALLING THEYDID
  38.                            5.  CONTROL FILE
  39.                            6.  PRODUCT SUPPORT
  40.  
  41.  
  42.  
  43.  
  44.    ──────────────────────────────────────────────────────────────────────────
  45.    1.  INTRODUCTION
  46.    ══════════════════════════════════════════════════════════════════════════
  47.  
  48.  
  49.      THEYDID is a lastcaller list processor designed to operate with
  50.      RemoteAccess or similiar systems creating a FrontDoor/Opus type of
  51.      logfile.
  52.      It creates a lastcaller list containing Usernames, Logon-, Logoff-,
  53.      Onlinetime and some Flag-Letters showing what the user did.
  54.      You can specify TheyDid to write the letter 'U' if it finds the
  55.      searchstring 'Upload' in the logfile, and so on.
  56.      TheyDid can show everything the user did, IF it can be found in the
  57.      logfile.
  58.  
  59.        ■ Supports ASCII(TTY), ANSI ans AVATAR outputs.
  60.          (AVATAR output is only available for Registered users)
  61.  
  62.        ■ Configurable sorting (First caller first/last)
  63.  
  64.        ■ Multilingual support as well as multiple file-outputs from one
  65.          Control-file.
  66.  
  67.        ■ Customisable outputs. Standard to screen or direct to file.
  68.          Standard output can be redirected to Com-ports from commandline.
  69.  
  70.        ■ Ability to specify users NOT to be shown in list.
  71.  
  72.        ■ Easy and Cheap registration.
  73.  
  74.          and MORE!
  75.  
  76.  
  77.    ──────────────────────────────────────────────────────────────────────────
  78.    2.  WARRANTY AND DISCLAIMER
  79.    ══════════════════════════════════════════════════════════════════════════
  80.  
  81.  
  82.      There is absolutely no warranty whatsoever.  THEYDID is provided
  83.      to the public AS IS without warranty of any kind, either expressed
  84.      or implied, including, but not limited to, the implied warranties of
  85.      merchantability and fitness for a particular purpose.
  86.      The entire risk as to the quality and performance of THEYDID, and the
  87.      accuracy of its associated documentation, is with YOU.
  88.      Should THEYDID or its associated documentation prove defective,
  89.      you assume the cost of all necessary servicing, repair or correction.
  90.  
  91.      In no event will the author of THEYDID be liable to you for damages,
  92.      including any lost profits, lost monies, or other special, incidental
  93.      or consequential damages arising out of the use or inability to use
  94.      THEYDID.  This includes, but is not limited to, loss of data or data
  95.      being rendered inaccurate or losses sustained by third parties or
  96.      failure of THEYDID to operate with any other program.
  97.  
  98.      
  99.      MS-DOS is Copyright 1981-1991 by Microsoft Corp
  100.  
  101.      RemoteAccess is Copyright 1993 by Wantree Development
  102.  
  103.  
  104.    ──────────────────────────────────────────────────────────────────────────
  105.    3.  REGISTRATION
  106.    ══════════════════════════════════════════════════════════════════════════
  107.  
  108.  
  109.      THEYDID is distributed under the CardWare concept. You are requested
  110.      to register this program if you intend to use it beyond the trial
  111.      period of 30 days.  
  112.  
  113.      Registration will enable you to use the registered only options.
  114.      Registered versions of THEYDID will identify itself with a registered
  115.      notice will replace the unregistered message at the end of the list.
  116.  
  117.  
  118.          *  For more information about registering read THEYDID.REG  *
  119.  
  120.  
  121.  
  122.    ──────────────────────────────────────────────────────────────────────────
  123.    4.  INSTALLING THEYDID
  124.    ══════════════════════════════════════════════════════════════════════════
  125.  
  126.  
  127.      To install TheyDid, just copy all files to any directory.
  128.      The archive should contain the following files:
  129.  
  130.             THEYDID.EXE     The executable file.
  131.             THEYDID.CTL     The control file for THEYDID
  132.             THEYDID.DOC     This documentation you are reading now
  133.             THEYDID.REG     Registration form and information
  134.             WHATSNEW.093    List of changes in THEYDID since version 0.75ß
  135.             README.1ST      Release notes for this version
  136.             FILE_ID.DIZ     THEYDID archive description
  137.  
  138.  
  139.     TheyDid runs on MS-DOS 3.0 or higher.
  140.  
  141.    ──────────────────────────────────────────────────────────────────────────
  142.    5.  CONTROL FILE
  143.    ══════════════════════════════════════════════════════════════════════════
  144.  
  145.  
  146.      THEYDID's control file is a plain ASCII text file which can be
  147.      edited by any text editor of your choice.
  148.      All comment lines are to be preceded by a percent sign (%).
  149.      DO NOT include tabs inside the configuration file.
  150.  
  151.      The general format of each configuration line is:
  152.  
  153.      <switch> = [options....]
  154.  
  155.      Options varies with different switches.  Some switches do not
  156.      need any options.  The following describes the various switches
  157.      and their options.
  158.  
  159.      THEYDID will look for the default configuration file THEYDID.CTL in
  160.      the directory where THEYDID is started from. Optionally, you may specify
  161.      an alternate configuration file using the /C command line parameter
  162.      (e.g. THEYDID /CC:/RA/THEYDID/SWEDISH.CTL).
  163.  
  164.  
  165.      This is all the commands You can specify in the controlfile.
  166.  
  167.  
  168.      $MAXUSER
  169.      ────────
  170.      How many users THEYDID will show in the list.
  171.      More than 10 not available in the unregistered version.
  172.     
  173.      example : $MAXUSER = 9
  174.  
  175.      Would display only the last 9 callers.
  176.  
  177.  
  178.      $BBSNAME
  179.      ────────
  180.      Here you write the name of your BBS. It will be used to write out
  181.      the name of your BBS in the list, and must also be the same as
  182.      you've specified at registration.
  183.  
  184.      example : $BBSNAME = AXiS Enterprise
  185.  
  186.      Would display 'AXiS Enterprise' in the output ;).
  187.  
  188.  
  189.      $HANDLES
  190.      ────────
  191.      This switch makes TheyDid write users Handles instead of name.
  192.      (Only Available in registered version)
  193.  
  194.  
  195.      $USERFILE
  196.      ─────────
  197.      If you have $HANDLES you must use this switch, with the
  198.      path and name to the userfile.
  199.  
  200.      example : $USERFILE = C:\MSGBASE\USERS.BBS
  201.  
  202.  
  203.      $SYSCRASH
  204.      ─────────
  205.      This little switch turns on the System-Crash watch.
  206.      It makes TheyDid look for user-entries that end without
  207.      normal 'Lost Carrier'.
  208.      You can also specify what TheyDid shall write.
  209.  
  210.      example : $SYSCRASH = It Just Went DOWN!
  211.  
  212.      Would display 'It Just Went DOWN' after the last caller online
  213.      before the crash.
  214.  
  215.  
  216.      After the following switches you can specify another word for 'AT'.
  217.      If you make lists in another language than english or just want
  218.      another wird there. Default word is the switch.. ;)
  219.  
  220.      $AT
  221.      $USER
  222.      $SPEED
  223.      $ON
  224.      $OFF
  225.      $ONLINE
  226.      $HADDID
  227.  
  228.      example : $SPEED = Bits/Second
  229.  
  230.      Would display 'Bits/Second' instead of 'Speed' over all Connect
  231.      speeds.
  232.  
  233.  
  234.      $REVERSE
  235.      ────────
  236.      Makes Theydid write the last user first and first user last.
  237.  
  238.  
  239.      $NOREVERSE
  240.      ──────────
  241.      This switch turns OFF reverse, and makes Theydid write the
  242.      first user first.....
  243.  
  244.  
  245.      $TTY
  246.      ────
  247.      This switch activates the ASCII/TTY output. If an ANSI or AVATAR
  248.      switch comes after this one, TheyDid switched to that mode.
  249.      You must have an $OUTPUT switch before changing graphics mode.
  250.  
  251.  
  252.      $ANSI
  253.      ─────
  254.      Activates ANSI output. (Default)
  255.  
  256.  
  257.      $AVATAR
  258.      ───────
  259.      Activates AVATAR output. (Only in Registered Mode)
  260.      
  261.  
  262.      $PRESSENTER
  263.      ───────────
  264.      Intructs TheyDid to add a PressEnter character at the end of the list.
  265.      In this case, the PressEnter character is a [CTRL-A] (Aka [ALT-1])
  266.  
  267.  
  268.      $NOPRESSENTER
  269.      ─────────────
  270.      Take a wild guess. Ofcourse it turns of the above switch.
  271.  
  272.  
  273.      $INPUT
  274.      ──────
  275.      Here you must specify the name of the logfile or path and name.
  276.  
  277.      example : $INPUT = C:\RA\RA.LOG
  278.  
  279.      Would cause TheyDid to read the file C:\RA\RA.LOG.
  280.  
  281.  
  282.      $INFOLINE1
  283.      ──────────
  284.      Here You can specify the meaning of the 'User Did Flags' or just
  285.      write some nonsens.....
  286.      If you are thinking of explaining what the flags mean, TheyDid
  287.      is capable of a smart thing to make it easier for users to see.
  288.  
  289.      example : $INFOLINE1 = [U]pload [D]ownload [R/W] Msgs
  290.  
  291.      This example would instruct TheyDid to output the [ and ] in light blue
  292.      color, and the U and D will be in light cyan. The "/" will be
  293.      displayed in the same color as the test outside []'s.       (?);)
  294.      You can seperate INFOLINES1 and 3 if you put an $LINE at
  295.      INFOLINE2.
  296.  
  297.      example : $INFOLINE2 = $LINE
  298.  
  299.      Would display a shaded line, exactly like the other lines.
  300.  
  301.  
  302.      $INFOLINE2
  303.      ──────────
  304.      Same here.......................
  305.  
  306.  
  307.      $INFOLINE3
  308.      ──────────
  309.      And here........................
  310.  
  311.  
  312.      $CLEAR
  313.      ──────
  314.      This switch resets all language configurable switches to Default.
  315.      Prepares for new language. I don't really know if this switch is
  316.      really necessery ;).
  317.  
  318.  
  319.      $OUTPUT
  320.      ───────
  321.      Destination of the output. If you don't specify this switch,
  322.      output goes to screen, and can from there be redirected to
  323.      a file or a Com-Port.
  324.  
  325.      example 1: $OUTPUT = C:\RA\TXTFILES\THEYDID.ANS
  326.  
  327.      Will redirect output to the file THEYDID.ANS in specified
  328.      directory.
  329.  
  330.      example 2: $OUTPUT =
  331.  
  332.      Will redirect output to the screen, and can be redirected from
  333.      the command line, to File or Com-port.
  334.  
  335.      example : THEYDID.EXE > COM1
  336.  
  337.      This will ofcourse redirect the output to the Comport number 1.
  338.  
  339.  
  340.      SEARCHSTRINGS & FLAGS
  341.      ─────────────────────
  342.  
  343.      And now for the harder part - User Did flag configuration.
  344.      The flags are refered to 'CharToShow'.
  345.  
  346.      Syntax : SEARCHSTRING,CHARTOSHOW,CHARPOS,PRIORITY.
  347.  
  348.      SEARCHSTRING
  349.      ────────────
  350.      The string of characters TheyDid will look for in the log file.
  351.  
  352.  
  353.      CHARTOSHOW
  354.      ──────────
  355.      The Character TheyDid will show if it finds the SEARCHSTRING.
  356.  
  357.  
  358.      CHARPOS
  359.      ───────
  360.      It's a number between 1 and 10, where to place the CHARTOSHOW.
  361.  
  362.  
  363.      PRIORITY
  364.      ────────
  365.      It's a number between 1 and 10 telling TheyDid what priority the flag
  366.      has. This is used if two or more CHARTOSHOW share the same CHARPOS.
  367.  
  368.  
  369.      example 1 : IEMSI,I,1,1
  370.                  Upload,U,2,1
  371.  
  372.      The first line will write an "I" at position "1" if TheyDid finds
  373.      the String "IEMSI" in the logfile.
  374.  
  375.      The second line will write a "U" at position "2" if TheyDid fins
  376.      the string "Upload" in the logfile.
  377.  
  378.  
  379.      example 2 : Lost carrier,B,7,1
  380.                  requested to terminate,-,7,3
  381.                  Timelimit exceeded,X,7,2
  382.  
  383.      If TheyDid finds "Lost Carrier" it will write an "B" (for BadLogoff)
  384.      at "7".
  385.      But if TheyDid also finds "Timelimit exceeded", it will instead write
  386.      an "X".
  387.      And if "requested to terminate" is found instead of "Time /../"
  388.      Theydid will write a "-", because the user requested to terminate the
  389.      call, and then hung up. (Nothing to report...)
  390.  
  391.  
  392.      You may also exclude some users if there is some you don't want to
  393.      be in the list. You just put there names with a '#' infront,
  394.      at the end of the control file.
  395.  
  396.      example : #Sysop
  397.                #Niclas Pettersson
  398.  
  399.  
  400.      The size of the CTL-file will not effect the speed of TheyDid if You are
  401.      using a HardDisk unless the size is larger then 2048 bytes.
  402.  
  403.  
  404.    ──────────────────────────────────────────────────────────────────────────
  405.    6.  PRODUCT SUPPORT
  406.    ══════════════════════════════════════════════════════════════════════════
  407.  
  408.  
  409.      If you encounter any difficulties, problems or bugs when using this
  410.      software, you can contact any of the support sites listed below. We
  411.      are always eager to listen to your comments, complaints or suggestions.
  412.  
  413.  
  414.      THEYDID Programmer
  415.  
  416.      ■ Niclas Pettersson
  417.        Pl. 274 Karr
  418.        S-310 10 Vaxtorp
  419.        SWEDEN
  420.  
  421.  
  422.      THEYDID Beta/Support and World HQ:
  423.  
  424.      ■ Andreas Olsson
  425.        AXiS, Sweden
  426.        +46-8-52016282, V32"
  427.        24 hours daily
  428.        Fidonet   : 2:201/261.2
  429.        ChateuNet : 101:1001/301
  430.  
  431.  
  432.  
  433. [End of Manual - Partly Copied]
  434.